<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>rfdc: xrfdc_mts_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">rfdc
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xrfdc__mts__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xrfdc_mts_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>RFSoC MultiTile Sync Example test application. </p>
<p>This example calls the RFdc Multi-tile-sync (MTS) API with the following configuration: Tiles to Sync: DAC0, DAC1, ADC0, ADC1, ADC2, ADC3.</p>
<p>MTS expects the PL clock, the AXI stream clock and the FS to all be compatible for it to function correctly. More information surrounding this can be found in PG269. </p>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
3.1   jm     01/24/18 First release
5.0   sk     09/05/18 Rename XRFdc_MTS_RMW_DRP as XRFdc_ClrSetReg.
5 0   mus    08/18/18 Updated to remove xparameters.h dependency for linux
                      platform.
6.0   cog    02/21/19 Removed unnecessary register writes.
             02/21/19 Set frequency and sample rate to appropriate values
                      for MTS.
             02/21/19 Set metal log level to DEBUG.
7.0   cog    07/25/19 Updated example for new metal register API.
8.1   cog    08/28/20 Make the example toatally generic, updated information.
10.0  cog    11/26/20 xrfdc_mts.h is now integrated to <a class="el" href="xrfdc_8h.html">xrfdc.h</a>.
      cog    03/08/21 MTS now scans reference tile first. This has required a
                      change to the prototype of XRFdc_MultiConverter_Init.</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad715e4bd581993df1ad8add6b078331b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrfdc__mts__example_8c.html#ad715e4bd581993df1ad8add6b078331b">RFdcMTS_Example</a> (u16 RFdcDeviceId)</td></tr>
<tr class="memdesc:ad715e4bd581993df1ad8add6b078331b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function runs a MTS test on the RFSoC data converter device using the driver APIs.  <a href="#ad715e4bd581993df1ad8add6b078331b">More...</a><br/></td></tr>
<tr class="separator:ad715e4bd581993df1ad8add6b078331b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrfdc__mts__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function that invokes the MTS example in this file.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function that invokes the MTS example in this file. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XRFDC_SUCCESS if the example has completed successfully.</li>
<li>XRFDC_FAILURE if the example has failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xrfdc__mts__example_8c.html#ad715e4bd581993df1ad8add6b078331b">RFdcMTS_Example()</a>.</p>

</div>
</div>
<a class="anchor" id="ad715e4bd581993df1ad8add6b078331b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RFdcMTS_Example </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>RFdcDeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function runs a MTS test on the RFSoC data converter device using the driver APIs. </p>
<p>This function does the following tasks:</p>
<ul>
<li>Initialize the RFdc device driver instance</li>
<li>Test MTS feature.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">RFdcDeviceId</td><td>is the XPAR_&lt;XRFDC_instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XRFDC_SUCCESS if the example has completed successfully.</li>
<li>XRFDC_FAILURE if the example has failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="group___overview.html#ga259ea2f270f0ce46ac06912cd7dcdfb9">XRFdc_CfgInitialize()</a>, <a class="el" href="group___overview.html#ga1299f0dcedca852a5a37e7bb1aa4d646">XRFdc_GetDecimationFactor()</a>, <a class="el" href="group___overview.html#ga24bd6bd466b879bbccb7795cc7bce579">XRFdc_GetInterpolationFactor()</a>, <a class="el" href="group___overview.html#ga80407a3a6737440fa38fc79eee240ad2">XRFdc_LookupConfig()</a>, <a class="el" href="group___overview.html#gaccab0c774a971a73089115245cfe1865">XRFdc_MultiConverter_Init()</a>, <a class="el" href="group___overview.html#ga032b44b96776ed88ed58464b1d014d63">XRFdc_MultiConverter_Sync()</a>, and <a class="el" href="group___overview.html#ga415b909c08102db406ea819a6c744add">XRFdc_RegisterMetal()</a>.</p>

<p>Referenced by <a class="el" href="xrfdc__mts__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
